Area Object

The Area Object represents an area in a report. An area is a group of like sections in the report (i.e., Details A - Da, Details B - Db, etc.) that all share the same characteristics. Each section within the area can be formatted differently. This object allows you to retrieve information and set options for a specified area in your report.

Area Object Properties

Property Description Read/Write Restriction in event handler

CopiesToPrint

Integer. Gets or sets the number of copies of each item in the Details section of the report. For example, by default, each line of the Details section only prints once. By setting this to 3, each line of the Details section would print 3 times.

Read/Write

Can be written only when formatting idle.

DetailHeight

Long. Gets the mailing label report deatil area height, in twips.

Read only

None

DetailWidth

Long. Gets multiple column report detail area width, in twips.

Read only

None

DiscardOther
Groups

Boolean. Gets or sets the discard other groups option.

Read/Write


Enable
Hierarchical
GroupSorting

Boolean. Gets or sets group hierarchically flag.

Read/Write

Fromatting idle.

GroupCondition

CRGroupCondition. Gets or sets the group condition.

Read/Write

Can be written only when formatting idle.

GroupCondition
Field

Object. Gets or sets the group condition field.

Read/Write

Can be written only when formatting idle.

GroupIndent

Long. Gets or sets group indent, in twips.

Read/Write

Fromatting idle.

GroupNumber

Integer. If the area is a group area, this returns the group number. Otherwise, exception is thrown.

Read only

None

HideFor
DrillDown

Boolean. Gets or sets hide for drill down option.

Read/Write

Can be written only when formatting idle.

HorizontalGap

Long. Gets the horizontal gaps going across page in a multiple column report.

Read only

None

InstanceIDField

FieldDefinition Object. Gets the instance ID field

Read only

Fromatting idle.

KeepGroup
Together

Boolean. Gets or sets the keep group together option.

Read/Write

Can be written only when formatting idle.

KeepTogether

Boolean. Gets or sets the keep area together option.

Read/Write

Can be written only when formatting idle.

Kind

CRAreaKind. Gets which kind of area (for example, Details, Report Header, Page Footer, etc.).

Read only

None

Name

String. Gets or sets the area name.

Read/Write

Can be written only when formatting idle.

NewPageAfter

Boolean. Gets or sets the new page after options.

Read/Write

Can be written only when formatting idle.

NewPageBefore

Boolean. Gets or sets the new page before option.

Read/Write

Can be written only when formatting idle.

NumberOfTop
OrBottomN
Groups

Integer. Gets or sets the number of top or bottom groups.

Read/Write

Formatting idle.

Parent

Report Object. Gets reference to the parent object.

Read Only

None

ParentIDField

FieldDefinition Object. Gets the parent ID field.

Read only

Formatting idle.

PrintAtBottom
OfPage

Boolean. Gets or sets the print at bottom of page option.

Read/Write

Can be written only when formatting idle.

RepeatGroup
Header

Boolean. Gets or sets the repeating group header option.

Read/Write

Can be written only when formatting idle.

ResetPage
NumberAfter

Boolean. Gets or sets the reset page number after option.

Read/Write

Can be written only when formatting idle.

Sections

Sections Collection. Gets a Collection of all the sections in the area.

Read Only

None

SortDirection

CRSortDirection. Gets or sets the group sort direction.

Read/Write

Can be written only when formatting idle.

Suppress

Boolean. Gets or sets the area visibility.

Read/Write

Can be written only when formatting idle.

TopOrBottom
NGroupSort
Order

CRTopOrBottomNGroupSortOrder. Gets or sets the top or bottom N group sort order.

Read/Write

Formatting idle.

TopOrBottom
NSortField

SummaryFieldDefinition Object. Gets or sets the top or bottom n sort field.

Read/Write

Formatting idle.



Seagate Software IMG Holdings, Inc.
http://www.seagatesoftware.com
Support services:
http://support.seagatesoftware.com